/**
 * com.chaeron.GPS - An API for access to GPS devices.
 *
 *
 * Copyright (c) 2001, 2002 Chaeron Corporation,
 * All rights reserved.
 * 
 * Chaeron grants you a non-exclusive license to use, modify and re-distribute
 * this program under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version, provided that this copyright notice and 
 * license appear on all copies of the software.
 * 
 * Software is provided "AS IS," without a warranty of any kind. ALL EXPRESS OR
 * IMPLIED REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
 * HEREBY EXCLUDED. THE ENTIRE RISK ARISING OUT OF USING THE SOFTWARE IS ASSUMED
 * BY THE LICENSEE. See the GNU General Public License for more details.
 *
 * CHAERON AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY
 * LICENSEE OR ANY THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING SOFTWARE.
 * IN NO EVENT WILL CHAERON OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE,
 * PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL
 * OR PUNITIVE DAMAGES, HOWEVER CAUSED AN REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF CHAERON HAS
 * BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

 * @version     1.02
 * @author      Andrzej Jan Taramina, Chaeron Corporation
 *              andrzej@chaeron.com
 */

package com.chaeron.GPS.event.decorator;

//***************************************************************************
//*
//*     Imports
//*
//***************************************************************************/

import com.chaeron.GPS.*;
import com.chaeron.GPS.event.*;

import com.chaeron.platform.common.*;


//***************************************************************************
//*
//*    GPSTrackLogDecorator Class definition
//*
//***************************************************************************/

/**
 * The GPSTrackLogDecorator provides added functions to the GPSTrackLog Event Value
 *
 */
 
public class GPSTrackLogDecorator extends GPSEventDecorator implements GPSTrackLog
{

	//***************************************************************************
	//*
	//*     Constant definitions
	//*
	//***************************************************************************/
	
	//***************************************************************************
	//*
	//*     Attributes
	//*
	//***************************************************************************/
	
	private	GPSTrackLog			delegate	= null;
	

	//***************************************************************************
	//*
	//*     Constructor
	//*
	//***************************************************************************/
	
	/**
	 * Create a GPSTrackLogDecorator
	 *
	 * @param	tracklog	GPSTrackLog to delegate method calls to
	 */
	
	public GPSTrackLogDecorator( GPSTrackLog tracklog )
	{
		super();
		
		delegate = tracklog;
	}
	
	//***************************************************************************
	//*
	//*     Output Methods (required by abstract base class)
	//*
	//***************************************************************************/
	
	void toXMLImpl( boolean namespace )
	{
		if( Compile.INCLUDE_EVENT_TOXML ) {
			writeString( genXMLStartTag( GPSXMLTag.XML_TAG_TRACKLOG, namespace ) );
			
			if( isMethodImplemented( TRACKLOG_METHOD_IDENTIFICATION ) ) {
				writeString( genXMLValueTag( GPSXMLTag.XML_TAG_IDENTIFIER, delegate.getIdentification() ) );
			}

			if( isMethodImplemented( TRACKLOG_METHOD_COLOUR ) ) {
				writeString( genXMLValueTag( GPSXMLTag.XML_TAG_COLOUR, String.valueOf( delegate.getColour() ) ) );
			}
			
			if( isMethodImplemented( TRACKLOG_METHOD_DISPLAY ) ) {
				writeString( genXMLValueTag( GPSXMLTag.XML_TAG_TRACKDISPLAYONMAP, String.valueOf( delegate.getDisplay() ) ) );
			}
			
			childrenToXML();

			writeString( genXMLEndTag( GPSXMLTag.XML_TAG_TRACKLOG ) ) ;
		}
	}
	
	
	private void childrenToXML()
	{
		Vector						trackpoints		= delegate.getTrackPoints();
		GPSTrackPointDecorator		trackpoint		= null;
			
		if( isMethodImplemented( TRACKLOG_METHOD_TRACKPOINTS ) && trackpoints != null ) {
			
			for( int i = 0; i < trackpoints.getCount(); i++ ) {
				trackpoint = (GPSTrackPointDecorator)trackpoints.get( i );
				
				if( trackpoint.isMethodImplemented( GPSTrackPointDecorator.TRACKPOINT_METHOD_NEWSEGMENT ) ) {
					if( trackpoint.getNewSegment() ) {
						if( i != 0 ) {
							writeString( genXMLEndTag( GPSXMLTag.XML_TAG_TRACKSEGMENT ) ) ;
						} 
						
						writeString( genXMLStartTag( GPSXMLTag.XML_TAG_TRACKSEGMENT, false ) ) ;
					}
				} else {
					if( i == 0 ) {
						writeString( genXMLStartTag( GPSXMLTag.XML_TAG_TRACKSEGMENT, false ) ) ;
					}
				}
			
				writeString( trackpoint.childToXML( getOutCatalog() ) );		
			}
			
			writeString( genXMLEndTag( GPSXMLTag.XML_TAG_TRACKSEGMENT ) ) ;
		}
	}

	
	//***************************************************************************
	//*
	//*     Delegated Interface Methods
	//*
	//***************************************************************************/

	public boolean getDisplay()
	{
		return( delegate.getDisplay() );
	}

	public String getIdentification()
	{
		return( delegate.getIdentification() );
	}

	public byte getColour()
	{
		return( delegate.getColour() );
	}
	
	public Vector getTrackPoints()
	{
		return( delegate.getTrackPoints() );
	}
	
}
